BeginSendIcmp(String,Int32,Int32,Byte[],Object) Method

Asynchronously determine if a host is reachable, specifying a TTL, sequence number, and additional data to send.

[Visual Basic]
<DescriptionAttribute("Begin an asynchronous ICMP Ping with a remote host, local host, the data sent, and any object.")>
Overloads Public Function BeginSendIcmp( _
   ByVal remoteHost As String, _
   ByVal TTL As Integer, _
   ByVal sequenceNumber As Integer, _
   ByVal data() As Byte, _
   ByVal state As Object _
) As Integer

[C#]
[DescriptionAttribute("Begin an asynchronous ICMP Ping with a remote host, local host, the data sent, and any object.")]
public int BeginSendIcmp( 
   string remoteHost,
   int TTL,
   int sequenceNumber,
   byte[] data,
   object state
);

[C++]
[DescriptionAttribute("Begin an asynchronous ICMP Ping with a remote host, local host, the data sent, and any object.")]
public: int BeginSendIcmp( 
   string* remoteHost,
   int TTL,
   int sequenceNumber,
   byte[]* data,
   Object* state
) 

[C++/CLI]
[DescriptionAttribute("Begin an asynchronous ICMP Ping with a remote host, local host, the data sent, and any object.")]
public:
int BeginSendIcmp( 
   String^ remoteHost,
   int TTL,
   int sequenceNumber,
   bytearray<data>^ data,
   Object^ state
) 

Parameters

remoteHost

Hostname or dot address of the host to ping.

TTL

The maximum amount of hops to take.

sequenceNumber

An identification number.

data

Additional data to send with the ping.

state

User state information.

Return Type

The number of bytes sent to remoteHost.

Exceptions

Remarks

This method pings the host (or hosts if a broadcast address is used) specified by remoteHost with the settings specified by TTL, sequenceNumber, and data. Upon completion the EndSend event is raised (multiple times if multiple hosts respond to a broadcast request). An EchoResult object is made accessible in the event, describing the ping operation. Check the properties of the EchoResult for data about the Ping operation. For example, ResponseTime returns the amount of time for the response to be received.

BeginSendIcmp differs from BeginSend in that multiple requests are all sent on a single thread as opposed to BeginSend which each request is made on a separate thread, which may limit the number of outstanding requests to the number of available threads. BeginSendIcmp is nearly unlimited in the number of outstanding requests it may have.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also

Ping Class  | Ping Members  | Overload List